prompt-sync

What is prompt-sync?

The prompt-sync npm package is a simple, synchronous way to get user input from the command line in Node.js applications. It is particularly useful for small scripts and command-line tools where asynchronous input handling is not necessary.

What are prompt-sync's main functionalities?

Basic Input

This feature allows you to prompt the user for input and capture their response synchronously. The example code asks the user for their name and then greets them.

const prompt = require('prompt-sync')();
const name = prompt('What is your name? ');
console.log(`Hello, ${name}!`);

Default Values

You can provide a default value that will be used if the user simply presses Enter without typing anything. The example code asks for the user's favorite color and defaults to 'blue' if no input is provided.

const prompt = require('prompt-sync')();
const color = prompt('What is your favorite color? ', 'blue');
console.log(`Your favorite color is ${color}.`);

Hidden Input

This feature allows you to hide the user's input, which is useful for sensitive information like passwords. The example code prompts the user for a password and masks the input with asterisks.

const prompt = require('prompt-sync')();
const password = prompt('Enter your password: ', {echo: '*'});
console.log('Password received.');

Other packages similar to prompt-sync

readline-sync

The readline-sync package provides similar synchronous input capabilities but with more advanced features like input validation, history, and autocompletion. It is more feature-rich compared to prompt-sync but also slightly more complex to use.

inquirer

Inquirer is a more advanced package for handling user input in command-line applications. It supports asynchronous prompts, multiple types of questions (e.g., lists, checkboxes), and more complex workflows. It is more suitable for larger applications that require more sophisticated user interactions.

README

SYNOPSIS

A sync prompt for node. very simple. no C++ bindings and no bash scripts.

USAGE

//
// write some text to the screen.
//
process.stdout.write('How many more times? ');

//
// get input from the user.
//
var n = prompt();

//
// do something dumb with it.
//
process.stdout.write(n + ' is ' + n + 'times too many');